<?php
/**********************************************************************
 *  Author: Justin Vincent (jv@vip.ie)
 *  Web...: http://justinvincent.com
 *  Name..: ezSQL
 *  Desc..: ezSQL Core module - database abstraction library to make
 *          it very easy to deal with databases. ezSQLcore can not be used by 
 *          itself (it is designed for use by database specific modules).
 *
 */
define('EZSQL_VERSION','2.12');
define('OBJECT','OBJECT',true);
define('ARRAY_A','ARRAY_A',true);
define('ARRAY_N','ARRAY_N',true);

/**********************************************************************
 *  Core class containg common functions to manipulate query result
 *  sets once returned
 */

class ezSQLcore
{

	protected $trace            = false;  // same as $debug_all
	protected $debug_all        = false;  // same as $trace
	protected $debug_called     = false;
	protected $vardump_called   = false;
	protected $show_errors      = true;
	protected $num_queries      = 0;
	protected $last_query       = null;
	protected $last_error       = null;
	public $col_info         = null;
	protected $captured_errors  = array();
	protected $cache_dir        = false;
	protected $cache_queries    = false;
	protected $cache_inserts    = false;
	protected $use_disk_cache   = false;
	protected $cache_timeout    = 24; // hours
	protected $timers           = array();
	protected $total_query_time = 0;
	protected $db_connect_time  = 0;
	protected $trace_log        = array();
	protected $use_trace_log    = false;
	protected $sql_log_file     = false;
	protected $do_profile       = false;
	protected $profile_times    = array();

	// == TJH == default now needed for echo of debug function
	protected $debug_echo_is_on = true;

	function __construct()
	{
	}

	/**********************************************************************
	 *  Print SQL/DB error - over-ridden by specific DB class
	 */

	public function registerError($err_str)
	{
		// Keep track of last error
		$this->last_error = $err_str;

		// Capture all errors to an error array no matter what happens
		$this->captured_errors[] = array
			(
				'error_str' => $err_str,
				'query'     => $this->last_query
			);
	}

	public function showErrors()
	{
		$this->show_errors = true;
	}

	public function hideErrors()
	{
		$this->show_errors = false;
	}

	/**********************************************************************
	 *  Kill cached query results
	 */
	public function flush()
	{
		// Get rid of these
		$this->last_result = null;
		$this->col_info = null;
		$this->last_query = null;
		$this->from_disk_cache = false;
	}

	/**********************************************************************
	 *  Get one variable from the DB - see docs for more detail
	 */
	public function getVar($query=null,$x=0,$y=0)
	{
		// Log how the function was called
		$this->func_call = "\$db->get_var(\"$query\",$x,$y)";
		// If there is a query then perform it if not then use cached results..
		if ( $query )
		{
			$this->query($query);
		}

		if ( $this->last_result[$y] )
		{
			//$values = array_values(get_object_vars($this->last_result[$y]));
			$values = array_values($this->last_result[$y]);
		}

		// If there is a value return it else return null
		return (isset($values[$x]) && $values[$x]!=='')?$values[$x]:null;
	}

	/**********************************************************************
	 *  Get one row from the DB - see docs for more detail
	 */
	public function getRow($query=null,$output=ARRAY_A,$y=0)
	{
		// Log how the function was called
		$this->func_call = "\$db->getRow(\"$query\",$output,$y)";
		// If there is a query then perform it if not then use cached results..
		if ( $query )
		{
			$this->query($query);
		}
		// If the output is an object then return object using the row offset..
		if ( $output == OBJECT )
		{
			return $this->last_result[$y]?(object)($this->last_result[$y]):null;
		}
		// If the output is an associative array then return row as such..
		elseif ( $output == ARRAY_A )
		{
			return $this->last_result[$y]?$this->last_result[$y]:null;
		}
		// If the output is an numerical array then return row as such..
		elseif ( $output == ARRAY_N )
		{
			return $this->last_result[$y]?array_values($this->last_result[$y]):null;
		}
		// If invalid output type was specified..
		else
		{
			$this->print_error(" \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N");
		}

	}

	/**********************************************************************
	 *  Function to get 1 column from the cached result set based in X index
	 *  see docs for usage and info
	 */

	public function getCol($query=null,$x=0)
	{
		$new_array = array();
		// If there is a query then perform it if not then use cached results..
		if ( $query )
		{
			$this->query($query);
		}
		// Extract the column values
		for ( $i=0,$len=count($this->last_result); $i < $len; $i++ )
		{
			$new_array[$i] = $this->getVar(null,$x,$i);
		}

		return $new_array;
	}

	/**********************************************************************
	 *  Return the the query as a result set - see docs for more details
	 */
	public function getResults($query=null, $output = ARRAY_A)
	{
		$this->func_call = "\$db->getResults(\"$query\", $output)";
		if ( $query )
		{
			$this->query($query);
		}

		// Send back array of objects. Each row is an object
		if($output == ARRAY_A)
		{
			return $this->last_result;
		}
		elseif($output==OBJECT)
		{
			if($this->last_result)
			{
				$rtn=array();
				foreach($this->last_result as $k=>$v)
				{
					$rtn[]=(object)$v;
				}
				return $rtn;
			}
		}
		elseif ($output == ARRAY_N )
		{
			if ( $this->last_result )
			{
				$rtn=array();
				$i=0;
				foreach( $this->last_result as $row )
				{
					$rtn[$i] = array_values($row);
					$i++;
				}
				return $rtn;
			}
		}
		return null;
	}


	/**********************************************************************
	 *  Function to get column meta data info pertaining to the last query
	 * see docs for more info and usage
	 */
	public function getColInfo($info_type="name",$col_offset=-1)
	{

		if ( $this->col_info )
		{
			if ( $col_offset == -1 )
			{
				$i=0;
				foreach($this->col_info as $col )
				{
					$new_array[$i] = $col->{$info_type};
					$i++;
				}
				return $new_array;
			}
			else
			{
				return $this->col_info[$col_offset]->{$info_type};
			}

		}

	}

	/**********************************************************************
	 *  store_cache
	 */

	protected function storeCache($query,$is_insert)
	{
		// disk caching of queries
		if ( $this->use_disk_cache && ( $this->cache_queries && ! $is_insert ) || ( $this->cache_inserts && $is_insert ))
		{
			// The would be cache file for this query
			$cache_file = $this->cache_dir.'/'.md5($query);
			if ( ! is_dir($this->cache_dir) )
			{
				$this->registerError("Could not open cache dir: $this->cache_dir");
				$this->showErrors ? trigger_error("Could not open cache dir: $this->cache_dir",E_USER_WARNING) : null;
			}
			else
			{
				// Cache all result values
				$result_cache = array
					(
						'col_info' => $this->col_info,
						'last_result' => $this->last_result,
						'num_rows' => $this->num_rows,
						'return_value' => $this->num_rows,
					);
				error_log ( serialize($result_cache), 3, $cache_file);
			}
		}

	}

	/**********************************************************************
	 *  get_cache
	 */
	protected function getCache($query)
	{
		// Try to get previously cached version
		if ( $this->use_disk_cache && file_exists($cache_file) )
		{
			// The would be cache file for this query
			$cache_file = $this->cache_dir.'/'.md5($query);

			// Only use this cache file if less than 'cache_timeout' (hours)
			if ( (time() - filemtime($cache_file)) > ($this->cache_timeout*3600) )
			{
				unlink($cache_file);
			}
			else
			{
				$result_cache = unserialize(file_get_contents($cache_file));

				$this->col_info = $result_cache['col_info'];
				$this->last_result = $result_cache['last_result'];
				$this->num_rows = $result_cache['num_rows'];

				$this->from_disk_cache = true;

				// If debug ALL queries
				$this->trace || $this->debug_all ? $this->debug() : null ;

				return $result_cache['return_value'];
			}
		}

	}

	/**********************************************************************
	 *  Dumps the contents of any input variable to screen in a nicely
	 *  formatted and easy to understand way - any type: Object, Var or Array
	 */
	public function vardump($mixed='')
	{

		// Start outup buffering
		ob_start();

		echo "<p><table><tr><td bgcolor=ffffff><blockquote><font color=000090>";
		echo "<pre><font face=arial>";

		if ( ! $this->vardump_called )
		{
			echo "<font color=800080><b>ezSQL</b> (v".EZSQL_VERSION.") <b>Variable Dump..</b></font>\n\n";
		}

		$var_type = gettype ($mixed);
		print_r(($mixed?$mixed:"<font color=red>No Value / False</font>"));
		echo "\n\n<b>Type:</b> " . ucfirst($var_type) . "\n";
		echo "<b>Last Query</b> [$this->num_queries]<b>:</b> ".($this->last_query?$this->last_query:"NULL")."\n";
		echo "<b>Last Function Call:</b> " . ($this->func_call?$this->func_call:"None")."\n";
		echo "<b>Last Rows Returned:</b> ".count($this->last_result)."\n";
		echo "</font></pre></font></blockquote></td></tr></table>";
		echo "\n<hr size=1 noshade color=dddddd>";

		// Stop output buffering and capture debug HTML
		$html = ob_get_contents();
		ob_end_clean();

		// Only echo output if it is turned on
		if ( $this->debug_echo_is_on )
		{
			echo $html;
		}
		$this->vardump_called = true;

		return $html;

	}

	/**********************************************************************
	 *  Alias for the above function
	 */

	public function dumpvar($mixed)
	{
		$this->vardump($mixed);
	}

	/**********************************************************************
	 *  Displays the last query string that was sent to the database & a
	 * table listing results (if there were any).
	 * (abstracted into a seperate file to save server overhead).
	 */
	public function debug($print_to_screen=true)
	{
		ob_start();
		echo "<blockquote>";
		// Only show ezSQL credits once..
		if ( ! $this->debug_called )
		{
			echo "<font color=800080 face=arial size=2><b>ezSQL</b> (v".EZSQL_VERSION.") <b>Debug..</b></font><p>\n";
		}

		if ( $this->last_error )
		{
			echo "<font face=arial size=2 color=000099><b>Last Error --</b> [<font color=000000><b>$this->last_error</b></font>]<p>";
		}

		if ( $this->from_disk_cache )
		{
			echo "<font face=arial size=2 color=000099><b>Results retrieved from disk cache</b></font><p>";
		}

		echo "<font face=arial size=2 color=000099><b>Query</b> [$this->num_queries] <b>--</b> ";
		echo "[<font color=000000><b>$this->last_query</b></font>]</font><p>";

		echo "<font face=arial size=2 color=000099><b>Query Result..</b></font>";
		echo "<blockquote>";

		if ( $this->col_info )
		{
			// =====================================================
			// Results top rows
			echo "<table cellpadding=5 cellspacing=1 bgcolor=555555>";
			echo "<tr bgcolor=eeeeee><td nowrap valign=bottom><font color=555599 face=arial size=2><b>(row)</b></font></td>";

			for ( $i=0; $i < count($this->col_info); $i++ )
			{
				echo "<td nowrap align=left valign=top><font size=1 color=555599 face=arial>{$this->col_info[$i]->type} {$this->col_info[$i]->max_length}</font><br><span style='font-family: arial; font-size: 10pt; font-weight: bold;'>{$this->col_info[$i]->name}</span></td>";
			}
			echo "</tr>";

			if ( $this->last_result )
			{

				$i=0;
				foreach ( $this->getResults(null,ARRAY_N) as $one_row )
				{
					$i++;
					echo "<tr bgcolor=ffffff><td bgcolor=eeeeee nowrap align=middle><font size=2 color=555599 face=arial>$i</font></td>";

					foreach ( $one_row as $item )
					{
						echo "<td nowrap><font face=arial size=2>$item</font></td>";
					}

					echo "</tr>";
				}

			} // if last result
			else
			{
				echo "<tr bgcolor=ffffff><td colspan=".(count($this->col_info)+1)."><font face=arial size=2>No Results</font></td></tr>";
			}
			echo "</table>";
		} // if col_info
		else
		{
			echo "<font face=arial size=2>No Results</font>";
		}
		echo "</blockquote></blockquote><hr noshade color=dddddd size=1>";
		// Stop output buffering and capture debug HTML
		$html = ob_get_contents();
		ob_end_clean();
		// Only echo output if it is turned on
		if ( $this->debug_echo_is_on && $print_to_screen)
		{
			echo $html;
		}
		$this->debug_called = true;

		return $html;

	}

	/**********************************************************************
	 *  Timer related functions
	 */
	public function timerGetCur()
	{
		list($usec, $sec) = explode(" ",microtime());
		return ((float)$usec + (float)$sec);
	}

	public function timerStart($timer_name)
	{
		$this->timers[$timer_name] = $this->timerGetCur();
	}

	public function timerElapsed($timer_name)
	{
		return round($this->timerGetCur() - $this->timers[$timer_name],2);
	}

	public function timerUpdateGlobal($timer_name)
	{
		if ( $this->do_profile )
		{
			$this->profile_times[] = array
				(
					'query' => $this->last_query,
					'time' => $this->timerElapsed($timer_name)
				);
		}

		$this->total_query_time += $this->timerElapsed($timer_name);
	}

	/**********************************************************************
	 * Creates a SET nvp sql string from an associative array (and escapes all values)
	 *
	 *  Usage:
	 *
	 *     $db_data = array('login'=>'jv','email'=>'jv@vip.ie', 'user_id' => 1, 'created' => 'NOW()');
	 *
	 *     $db->query("INSERT INTO users SET ".$db->get_set($db_data));
	 *
	 *     ...OR...
	 *
	 *     $db->query("UPDATE users SET ".$db->get_set($db_data)." WHERE user_id = 1");
	 *
	 * Output:
	 *
	 *     login = 'jv', email = 'jv@vip.ie', user_id = 1, created = NOW()
	 */

	public function getSet($parms,$concat=',')
	{		
		$sql = '';
		foreach ( $parms as $field => $val )
		{
			if ( $val === 'true' ) $val = 1;
			if ( $val === 'false' ) $val = 0;

			if ( $val == 'NOW()' )
			{
				$sql .= "$field = ".$this->escape($val).$concat.' ';
			}
			else
			{
				$sql .= "$field = '".$this->escape($val)."'".$concat.' ';
			}
		}
		return substr($sql,0,-(strlen($concat)+1));
	}

	private function a2s($param,$concat='AND')
	{
		$str = '';
		$f = '';
		foreach($param as $key=>$item)
		{
			$str .= " $f `$key` = '".$this->escape($item)."'";
			$f = $concat;
		}
		return $str;
	}
  
	/**
	 * 插入数据到一张数据表
	 * @param string $tbl 被插入的数据表
	 * @param array $param 插入的数据
	 * @return int 插入的数据id或者受影响的数据条数
	 */
	public function insertData($tbl,$param,$method='INSERT')
	{
		$method=strtoupper($method);
		if(!in_array($method,array('INSERT','REPLACE')))
		{
			return 0;
		}
		if($tbl && is_array($param))
		{
			$sql = $method." INTO $tbl SET ".$this->getSet($param);
			$rtn=$this->query($sql);
			return $this->insert_id?$this->insert_id:$rtn;
		}
	}
	/**
	 * 更新数据
	 * @param string $tbl 被更新的数据表
	 * @param array|string $param 更新数据
	 * @param array|string $where 更新条件
	 * @return int 影响数据数
	 */	
	public function updateData($tbl,$param,$where)
	{
		if($tbl && $param && $where)
		{
			$sql = "UPDATE $tbl SET ".(is_array($param)?$this->getSet($param):$param)." WHERE ".(is_array($where)?$this->a2s($where,'AND'):$where);
			return $this->query($sql);
		}
	}

	/**
	 * 删除数据表信息
	 * @param string $tbl 被删除的数据表
	 * @param string|array 删除参数
	 * @return int 影响的数据条数
	 */
	public function delData($tbl,$param)
	{
		if($tbl && $param)
		{
			$sql="DELETE FROM $tbl WHERE ".(is_array($param)?$this->a2s($param,'AND'):$param);
			return $this->query($sql);
		}
	}
	/**
	 * 根据条件获取表
	 * @param string $tbl
	 * @param string|array $where
	 * @return array
	 */
	public function getData($tbl,$where,$offset=0,$limit=0)
	{
		$sql="SELECT * FROM $tbl";
		if($where)
		{
			$sql.=" WHERE ".(is_array($where)?$this->a2s($where,'AND'):$where);
		}
		if($limit)
		{
			$sql.=" LIMIT ".intval($offset).','.intval($limit);
		}
		return $this->getResults($sql);
	}
	/**
	 * 记录sql日志
	 * @param string $sql
	 * @param int $type
	 */
	protected function sqlLog($sql,$type='normal')
	{
		if(strncasecmp($sql,'set names',9))
		{
			if(defined('SQL_FILE') && SQL_FILE)
			{
				$logdir=dirname(SQL_FILE);
				if(!is_dir($logdir))
				{
					mkdir($logdir,0777,true);
				}
				$f=SQL_FILE.($type=='error'?'_error':'').'.'.date('Ymd');
			}
			else
			{
				$f='/tmp/sql'.($type=='error'?'_error':'').'.'.date('Ymd');
			}
			file_put_contents($f,$sql."\t".loginInfo('uname')."\t".date('Y-m-d H:i:s')."\n",FILE_APPEND);
		}
	}
}
